home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / c / cxref.exe / CXREF.DOC < prev    next >
Text File  |  1992-02-24  |  20KB  |  537 lines
  1.  
  2.  
  3.  
  4.  
  5.                   C xref - C language cross-reference utility. v2.0
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.                                        C xref
  24.                        The C language cross reference utility.
  25.                             (c) 1992 by David Archibald.
  26.  
  27.  
  28.  
  29.                   C xref - C language cross-reference utility. v2.0
  30.  
  31.  
  32.  
  33.                                   Table of Contents
  34.  
  35.                     Introduction:
  36.                        Registration information............... 101
  37.                        System requirements.................... 102
  38.                        What C xref does....................... 103
  39.                     Program output:
  40.                        Global variables and constants......... 201
  41.                        Summary list of functions.............. 202
  42.                        Verbose list of functions.............. 203
  43.                        Function tree.......................... 204
  44.                     Running C xref:
  45.                        The command line syntax................ 301
  46.                        The module names....................... 302
  47.                        The -x command......................... 303
  48.                        The -t command......................... 304
  49.                        The -s command......................... 305
  50.                        The -w command......................... 306
  51.                        The -l command......................... 307
  52.                        The -i command......................... 308
  53.                        The -n command......................... 309
  54.                        Command line examples.................. 310
  55.                   The reserved word file: RES_WORD.TXT........ 401
  56.                   What C xref ignores......................... 501
  57.  
  58.  
  59.  
  60.                   C xref - C language cross-reference utility. v2.0
  61.  
  62.  
  63.  
  64.           101  Registration information.
  65.  
  66.                C xref is a Shareware program, and copies of this program
  67.                and it's documentation may be freely distributed.
  68.  
  69.                Note: C xref and this document are copyrighted and may not
  70.                be modified in any manner.
  71.  
  72.                Individual copies may be licensed for $20. (Site licenses
  73.                are available for commercial use. Please write for details.)
  74.  
  75.                After registering you will be sent the latest version of C
  76.                xref, and, as they become available, any future updates.
  77.  
  78.  
  79.  
  80.                   C xref - C language cross-reference utility. v2.0
  81.  
  82.  
  83.  
  84.                                      Order Form
  85.  
  86.           Registration fee                              Fee   $   20.00
  87.           (Michigan residents please add 4% sales tax)  Tax         .80
  88.  
  89.                                                         Total $ _______
  90.  
  91.               Name:___________________________________________________
  92.  
  93.               Company:________________________________________________
  94.  
  95.               Address:________________________________________________
  96.  
  97.                      :________________________________________________
  98.  
  99.                      :________________________________________________
  100.  
  101.           Disk size:
  102.                     5 1/4:_____
  103.                     3 1/2:_____
  104.  
  105.                Send to:
  106.                          DA Software
  107.                          3717 Aldon Lane
  108.                          Flint, MI 48506
  109.  
  110.           (If you have any suggestions or comments about C xref, please
  111.           include them.)
  112.  
  113.           Comments:
  114.  
  115.  
  116.  
  117.                   C xref - C language cross-reference utility. v2.0
  118.  
  119.  
  120.  
  121.           102  System requirements.
  122.  
  123.                Config.sys file:
  124.                     The "file" statement in your config.sys file must equal
  125.                     at least 20. If it doesn't, then using EDLIN, or
  126.                     another ASCII text editor, change the "file" statement
  127.                     in your config.sys file so that it reads "file=20".
  128.                Memory limits:
  129.                     There is no minimum memory, but the number of modules
  130.                     you can cross-reference is dependent on the amount of
  131.                     memory you have. If C xref runs out of memory it will
  132.                     output an error message, and terminate.
  133.  
  134.           103  What it does.
  135.  
  136.                C xref is a cross-reference utility program for the C
  137.                programming language. It will read any number of your C text
  138.                modules and send the following to standard output:
  139.  
  140.                o    A list of the module's global variables and constants,
  141.                     along with the line numbers they appear on.
  142.                o    A summary listing of module's functions.
  143.                o    A verbose list of all the module's functions that
  144.                     includes: the name of the module it originates in, line
  145.                     of origin, users, callers, and what local and global
  146.                     variables appear in the function.
  147.                o    A tree that displays all of the functions calling
  148.                     hierarchy.
  149.  
  150.                Note: Remember, you can use DOS redirection to send the
  151.                     output else where; i.e. >LPT1.
  152.  
  153.  
  154.  
  155.                   C xref - C language cross-reference utility. v2.0
  156.  
  157.  
  158.  
  159.           201  Global variables and constants.
  160.  
  161.                C xref assumes that anything declared outside a function's
  162.                boundaries (from the function name to the function's closing
  163.                brace) is a global variable or constant.
  164.  
  165.                The global variable and constant cross-reference has the
  166.                following format:
  167.  
  168.           variable name [type]
  169.                {module name}  which line numbers in this module the 
  170.                               variable appears on.
  171.  
  172.                Sample output:
  173.  
  174.                char_pnt [char]
  175.                   {example.c   }  1
  176.                   {explfile.c  }  10    11    16    28    35    42
  177.                cnt [int]
  178.                   {example.c   }  4     11    32
  179.                   {explfile.c  }  8     14
  180.  
  181.  
  182.           202  Summary list of functions.
  183.  
  184.                The summary list has the following format:
  185.  
  186.           {module name}  :  line-of-origin  :  function name() [type]
  187.  
  188.           Note: a line-of-origin of [NONE] indicates that the function was
  189.           not in any of the modules cross-referenced.
  190.  
  191.                Sample output:
  192.  
  193.                {explfile.c  }   :    32      :   is_it_a_comma() [int]
  194.                {example.c   }   :    7       :   main()  [void]
  195.                {explfile.c  }   :    39      :   not_comma()  [char]
  196.                {example.c   }   :    25      :   open_file()  [FILE]
  197.  
  198.  
  199.  
  200.                   C xref - C language cross-reference utility. v2.0
  201.  
  202.  
  203.  
  204.           203  Verbose list of functions.
  205.  
  206.                The verbose list of functions has the following format:
  207.  
  208.             function name [type]  :   {module name}  :  line-of-origin
  209.  
  210.                   USERS:
  211.                     {module name}   the line numbers in this module that
  212.                                    reference this function.
  213.  
  214.                   CALLS:
  215.                    {module name}   function name()   {module}  func1()
  216.  
  217.                   LOCAL VARIABLES:
  218.                     variable name [type]. the line numbers in this function
  219.                                          it appears on.
  220.  
  221.                   GLOBAL VARIABLES:
  222.                     variable name [type]. the line numbers in this function
  223.                                          it appears on.
  224.  
  225.  
  226.                As with the summary listing, a line-of-origin of [NONE]
  227.                indicates that a function was referenced, but did not appear
  228.                in any of the modules cross-referenced.
  229.  
  230.                USERS are the line numbers in a module that call this
  231.                function.
  232.  
  233.                CALLS are other functions that this function references.
  234.  
  235.                LOCAL VARIABLES are any variable or constant that falls
  236.                between a function's name and it's closing brace.
  237.  
  238.           Note: As with your C compiler, whe